Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(multi-region): add operational simplification from Zeebe 8.6. #4205

Merged
merged 5 commits into from
Aug 30, 2024
Merged

chore(multi-region): add operational simplification from Zeebe 8.6. #4205

merged 5 commits into from
Aug 30, 2024

Conversation

Langleu
Copy link
Member

@Langleu Langleu commented Aug 28, 2024

Description

related to https://github.com/camunda/team-infrastructure-experience/issues/325 and https://github.com/camunda/product-hub/issues/2173.

This ticket contains the simplification of the dual-region operational procedure based on the new 8.6 changes in Zeebe.

It reworks for next (8.6):

  • the pictures of the operational procedure
  • the steps that need to be taken
  • the concept page including RPO / RTO
  • some smaller fixes here and there

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
    • either alpha5 or latest stable would be nice.
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@Langleu Langleu added component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed component:infex Issues related with InfEx project target:8.6 Issues included in the 8.6 release 8.6.0-alpha5 September 2024 alpha release labels Aug 28, 2024
@Langleu Langleu requested review from deepthidevaki, leiicamundi and a team August 28, 2024 09:29
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Aug 28, 2024 •
edited
Loading

👋 🤖 🤔 Hello! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.5/.

  • docs/self-managed/operational-guides/multi-region/img/10.svg
  • docs/self-managed/operational-guides/multi-region/img/11.svg
  • docs/self-managed/operational-guides/multi-region/img/12.svg
  • docs/self-managed/operational-guides/multi-region/img/13.svg
  • docs/self-managed/operational-guides/multi-region/img/14.svg
  • docs/self-managed/operational-guides/multi-region/img/15.svg
  • docs/self-managed/operational-guides/multi-region/img/3.svg
  • docs/self-managed/operational-guides/multi-region/img/4.svg
  • docs/self-managed/operational-guides/multi-region/img/5.svg
  • docs/self-managed/operational-guides/multi-region/img/6.svg
  • docs/self-managed/operational-guides/multi-region/img/7.svg
  • docs/self-managed/operational-guides/multi-region/img/8.svg
  • docs/self-managed/operational-guides/multi-region/img/9.svg

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

@Langleu
Copy link
Member Author

Langleu commented Aug 28, 2024

The change is intentional since 8.5 still uses the old procedure while was reworked for next (8.6)

@conceptualshark
Copy link
Contributor

Happy to take this on from a technical writing perspective - would you like me to wait for the initial engineering review first?

@conceptualshark conceptualshark self-requested a review August 28, 2024 13:10
@Langleu
Copy link
Member Author

Langleu commented Aug 28, 2024

Great to hear @conceptualshark 🙇 🚀!
Since it's a change of an existing document, I think it would be okay to have your review already!
The only thing I could imagine is that maybe a step has to be moved, but the content itself will remain.

deepthidevaki
deepthidevaki previously approved these changes Aug 28, 2024
View reviewed changes
Copy link
Contributor

@deepthidevaki deepthidevaki left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

One minor thing to change:

In Failover Step 1, it is not necessary to ensure network isolation between two regions anymore. Previously, we had to do it because we were recreating brokers with the same id on the other region which could create conflicts if the network was not isolated and both the old and new brokers exists at the same time.

docs/self-managed/operational-guides/multi-region/dual-region-ops.md Outdated Show resolved Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md Outdated Show resolved Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
--namespace $CAMUNDA_NAMESPACE_SURVIVING \
-f camunda-values.yml \
-f $REGION_SURVIVING/camunda-values.yml
curl -XGET 'http://localhost:9600/actuator/exporters'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💭 I will added a follow up PR to document the specs of this API.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great! I left a todo in the text where we should probably link it and only have a wrong placeholder atm.

docs/self-managed/operational-guides/multi-region/dual-region-ops.md Show resolved Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md Outdated Show resolved Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md Outdated Show resolved Hide resolved
docs/self-managed/concepts/multi-region/dual-region.md Outdated Show resolved Hide resolved
docs/self-managed/concepts/multi-region/dual-region.md Outdated Show resolved Hide resolved
@christinaausley
Copy link
Contributor

Happy to take this on from a technical writing perspective - would you like me to wait for the initial engineering review first?

@conceptualshark Going to remove @camunda/tech-writers here, but let us know if you're looking for additional review 👍

@christinaausley christinaausley removed the request for review from a team August 28, 2024 15:00
conceptualshark
conceptualshark requested changes Aug 28, 2024
View reviewed changes
Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few questions/suggestions, but otherwise this upgrade looks great!

docs/self-managed/concepts/multi-region/dual-region.md Show resolved Hide resolved
docs/self-managed/concepts/multi-region/dual-region.md Outdated Show resolved Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md Outdated Show resolved Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md Outdated Show resolved Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md Outdated Show resolved Hide resolved
@Langleu
Copy link
Member Author

Langleu commented Aug 29, 2024 •
edited
Loading

Thanks @deepthidevaki and @conceptualshark for the review 🙇.

Addressed all points except for the two that are left open, which we may have to realign on.

@deepthidevaki:

  • Good note on the isolation, I've added that information to the 8.5 procedure and removed it from 8.6
  • Also split up the steps with init and reactivation of the exporter to elastic.

// update: Addressed the remaining points.

leiicamundi
leiicamundi reviewed Aug 30, 2024
View reviewed changes
Copy link
Contributor

@leiicamundi leiicamundi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice additions!
I left a few comments about the readability of the documents, mainly suggesting the use of tables for comparisons

docs/self-managed/concepts/multi-region/dual-region.md Show resolved Hide resolved
versioned_docs/version-8.5/self-managed/operational-guides/multi-region/dual-region-ops.md Outdated Show resolved Hide resolved
versioned_docs/version-8.5/self-managed/setup/deploy/amazon/amazon-eks/dual-region.md Show resolved Hide resolved
leiicamundi
leiicamundi previously approved these changes Aug 30, 2024
View reviewed changes
@leiicamundi leiicamundi mentioned this pull request Aug 30, 2024
Merged
9 tasks
@Langleu
Copy link
Member Author

Langleu commented Aug 30, 2024

@conceptualshark could you do a last approval and feel free to merge afterwards!

I had to rebase the PR for the tests to pass.
Only changed since your approval:

@conceptualshark conceptualshark merged commit f697cf4 into main Aug 30, 2024
7 checks passed
@conceptualshark conceptualshark deleted the infraex-325 branch August 30, 2024 14:39
@deepthidevaki deepthidevaki mentioned this pull request Sep 5, 2024
Merged
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@deepthidevaki deepthidevaki deepthidevaki left review comments

@conceptualshark conceptualshark conceptualshark approved these changes

@leiicamundi leiicamundi leiicamundi left review comments

Assignees

@Langleu Langleu

Labels
8.6.0-alpha5 September 2024 alpha release component:infex Issues related with InfEx project component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed target:8.6 Issues included in the 8.6 release
Projects
Developer Experience
Status: ✅ Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@Langleu @conceptualshark @christinaausley @deepthidevaki @leiicamundi